Skip to content

Conversation

@skudasov
Copy link
Contributor

@skudasov skudasov commented Jul 10, 2025


Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes in the documentation aim to enhance the organization and accessibility of the content for users. By introducing folding in HTML output, restructuring the summary, and updating references to nodes and components, the documentation becomes more user-friendly and adaptable to various use cases. The focus on updating links and restructuring content reflects an effort to keep the documentation relevant and easy to navigate.

What

  • book/book.toml
    • Added HTML output folding configuration, enabling document folding with level 0.
  • book/src/SUMMARY.md
    • Streamlined the summary structure for clarity and better navigation. This includes combining related topics, removing outdated sections, and adding new categories like "Advanced Usage" and "Legacy".
  • book/src/developing.md
    • Updated a reference link from node.md to nodeset.md to reflect the current structure.
  • book/src/framework/cl_node_keys_import.md
    • Renamed and updated from nodeset_environment_import.md to focus on Chainlink node keys import.
  • Deleted Files
    • Removed node.md and nodeset.md from the framework components directory, indicating a shift or consolidation of documentation for Chainlink nodes.
  • book/src/framework/components/mocking.md
    • Renamed section from "Faking Services" to "Fake Services" for consistency.
  • book/src/framework/components/overview.md
    • Updated the components overview section to reflect the current composition of CTF components.
  • book/src/framework/getting_started.md
    • Updated prerequisites to recommend Docker Desktop, indicating a shift in recommended development environments.
  • book/src/framework/observability/observability_stack.md
    • Removed links to local setup help, suggesting a simplification of the observability documentation.
  • book/src/k8s-test-runner/k8s-test-runner.md
    • Added a warning about legacy status, preparing users for future deprecations.
  • book/src/legacy.md
    • Introduced a new file to categorize legacy documentation and code examples, aiming for better organization and clarity on deprecated features.
  • book/src/lib.md
    • Marked the Framework v1 as deprecated, guiding users towards updated versions or practices.
  • Deleted lib/crib.md
    • Removed documentation related to CRIB Connector, signaling a move away from GAPv1 support.

@skudasov skudasov requested a review from Tofel July 10, 2025 10:19
@skudasov skudasov marked this pull request as ready for review July 10, 2025 12:02
@skudasov skudasov requested a review from a team as a code owner July 10, 2025 12:02
@skudasov skudasov merged commit 3bd24ec into main Jul 10, 2025
65 checks passed
@skudasov skudasov deleted the docs-cleanup branch July 10, 2025 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants